[docs] Add basic documentation on using Snippets to DocC documentation #1166
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
heckj
changed the title
FYI: You can coauthor commits by including a line like this in the commit message: |
d-ronnqvist
reviewed
Mar 7, 2025
Sources/docc/DocCDocumentation.docc/Reference Syntax/API Reference Syntax/Snippet.md
Show resolved
Hide resolved
d-ronnqvist
reviewed
Mar 7, 2025
|
@JacobHearst @d-ronnqvist sorry for the delay in writing an overview. Added one based on @d-ronnqvist feedback, see what you think. |
Co-authored-by: Joe Heck <[email protected]> Co-authored-by: Jacob Hearst <[email protected]>
…a newline to the end of the file
…erated symbolgraph with that change
|
@swift-ci please test |
|
@swift-ci please tests |
patshaughnessy
requested changes
May 9, 2025
Sources/docc/DocCDocumentation.docc/Reference Syntax/API Reference Syntax/Snippet.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Pat Shaughnessy <[email protected]>
Co-authored-by: Pat Shaughnessy <[email protected]>
…ence Syntax/Snippet.md Co-authored-by: Pat Shaughnessy <[email protected]>
|
Thanks @patshaughnessy - accepted all suggestions and added a commit to rename the file per your suggestion. |
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Work towards resolving #417
Summary
Adds some base line documentation that describes how to use the snippets feature built in to DocC and the DocC Plugin.
Dependencies & Testing
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded(this pull request is the combined work of https://github.com/JacobHearst and myself, I just happen to be submitting it)